home *** CD-ROM | disk | FTP | other *** search
/ Aminet 5 / Aminet 5 - March 1995.iso / Aminet / dev / c / c2man_2_0pl33.readme < prev    next >
Text File  |  1995-02-12  |  9KB  |  159 lines
  1. Short:    Automated doc. from c sources (autodoc)
  2. Author:   ruppert@vs3.informatik.fh-wiesbaden.de
  3. Uploader: ruppert@vs3.informatik.fh-wiesbaden.de
  4. Type:     dev/misc
  5.  
  6. This is my port of the c2man patchlevel 33 for the Amiga.
  7.  
  8. I added a Commodore AutoDoc output format backend. So you can use this outputs
  9. with your favorite autodoc formatting utility. Read the c2man manual for
  10. getting started with c2man. If you have groff, a LaTeX package or makeinfo
  11. installed you can also use c2man for generating these output formats. I have
  12. tested the nroff format with the groff port 1.07.
  13.  
  14. I have compiled c2man with SAS-C V6.51 with the STACKCHECK option ON , because
  15. c2man requires more than the standard 4096 bytes. If you don't like this
  16. recompile it , but you must have bison/yacc and flex/lex ! A stack of 10000
  17. bytes seems enough .
  18.  
  19. For this port I used the popen implementation from the AmiTCP 4.0 demo package.
  20. The original version was written by Rick Schaeffer <ricks@isc-br.isc-br.com> and
  21. by Jarno Rajahalme from the AmiTCP/IP Group <Jarno.Rajahalme@hut.fi>.
  22.  
  23. You need also a preprocessor, which supports non-stripping of comments ! I used
  24. the cpp from the AmiTCP 4.0 demo package, but you can also use the cpp from gcc
  25. or gcc with "gcc -E -C".
  26.  
  27. The following option is added in the Amiga port :
  28.  
  29. -T a : select autodoc output format. This output format is default !
  30.  
  31. The following command shows, how you can use the c2man program (Note: this
  32. implies, that you have installed the Pipe package) :
  33.  
  34. c2man -o- your_c_source.c
  35.  
  36. c2man supports grouping of source files. This means if two source files are
  37. passed on the command line, each function in this files links to each other.
  38. But if you have two or more groups of such files you can use the following
  39. command :
  40.  
  41. c2man -o- csource1.c csource2.c || c2man -o- anothercsource.c | sortad to test.doc
  42.  
  43. This functions with the Pipe1_5.lha package, which uses the '||' to concate outputs.
  44.  
  45. sortad is used to put all docs together and to generate the sorted list of contents.
  46.  
  47. sortad is copyrighted by Stefan Ruppert, but is freely distributable with c2man !
  48.  
  49. Stefan Ruppert
  50. Windthorststraße 5
  51. 65439 Flörsheim am Main
  52. GERMANY
  53.  
  54. EMail: ruppert@vs3.informatik.fh-wiesbaden.de
  55.  
  56.  
  57. ============================= Archive contents =============================
  58.  
  59. Original  Packed Ratio    Date     Time    Name
  60. -------- ------- ----- --------- --------  -------------
  61.      410     296 27.8% 22-Jan-95 18:14:34  c2man-2.0/amiga/amiga.c
  62.     7393    1973 73.3% 25-Jan-95 22:37:20  c2man-2.0/amiga/autodoc.c
  63.    82188   42370 48.4% 25-Jan-95 22:37:42  c2man-2.0/amiga/c2man
  64.    25893    7150 72.3% 23-Jan-95 22:56:36  c2man-2.0/amiga/c2man.c
  65.     9915    2945 70.2% 21-Jan-95 16:51:12  c2man-2.0/amiga/config.h
  66.      696     376 45.9% 21-Jan-95 14:58:58  c2man-2.0/amiga/confmagic.h
  67.    27508   17074 37.9% 31-Jan-95 01:00:08  c2man-2.0/amiga/cpp
  68.    20925    7053 66.2% 13-Jan-95 22:34:58  c2man-2.0/amiga/getopt.c
  69.     4604    1820 60.4% 21-Jan-95 14:53:42  c2man-2.0/amiga/getopt.h
  70.    69577   18924 72.8% 23-Jan-95 23:03:58  c2man-2.0/amiga/lex.yy.c
  71.     4476    1417 68.3% 23-Jan-95 23:01:42  c2man-2.0/amiga/output.h
  72.     9490    3379 64.3% 30-Sep-94 01:10:08  c2man-2.0/amiga/popen.c
  73.       65      65  0.0% 22-Jan-95 21:45:50  c2man-2.0/amiga/project
  74.     2051    1054 48.6% 25-Jan-95 23:26:46  c2man-2.0/amiga/README
  75.     4918    1619 67.0% 26-Jan-95 00:13:40  c2man-2.0/amiga/SMakefile
  76.     3212    2164 32.6% 22-Jan-95 22:41:48  c2man-2.0/amiga/sortad
  77.     6364    1981 68.8% 22-Jan-95 22:32:04  c2man-2.0/amiga/sortad.c
  78.    60640   14027 76.8% 23-Jan-95 23:03:52  c2man-2.0/amiga/y.tab.c
  79.    11081    4558 58.8% 23-Jan-95 22:19:22  c2man-2.0/C++autodoc
  80.    20201    7710 61.8% 23-Jan-95 22:17:56  c2man-2.0/c2man.1
  81.    22037    6907 68.6% 23-Jan-95 22:19:26  c2man-2.0/c2man.c
  82.     7456    2469 66.8% 23-Jan-95 22:17:34  c2man-2.0/c2man.h
  83.     1377     488 64.5% 23-Jan-95 22:19:34  c2man-2.0/c2man.man.rej
  84.     2261    1120 50.4% 23-Jan-95 22:19:42  c2man-2.0/catalog
  85.     4086    1997 51.1% 13-Jan-95 22:35:04  c2man-2.0/CHANGES
  86.    10326    3359 67.4% 23-Jan-95 22:17:28  c2man-2.0/config_h.SH
  87.   104385   35082 66.3% 23-Jan-95 22:19:18  c2man-2.0/Configure
  88.      613     327 46.6% 13-Jan-95 22:35:06  c2man-2.0/confmagic.h
  89.      881     283 67.8% 13-Jan-95 22:35:06  c2man-2.0/ctype_ex.h
  90.     1357     179 86.8% 13-Jan-95 22:34:56  c2man-2.0/eg/boxcomment.c
  91.      670     263 60.7% 13-Jan-95 22:34:56  c2man-2.0/eg/ccomment.h
  92.       62      62  0.0% 13-Jan-95 22:34:58  c2man-2.0/eg/commentaft.c
  93.      439     205 53.3% 13-Jan-95 22:34:56  c2man-2.0/eg/cppcomment.h
  94.       51      50  1.9% 13-Jan-95 22:34:58  c2man-2.0/eg/dash.h
  95.      238     131 44.9% 13-Jan-95 22:34:58  c2man-2.0/eg/ellipsis.c
  96.      331     141 57.4% 13-Jan-95 22:34:56  c2man-2.0/eg/grouped.c
  97.      108      68 37.0% 13-Jan-95 22:34:58  c2man-2.0/eg/multidecl.c
  98.      180     133 26.1% 13-Jan-95 22:34:56  c2man-2.0/eg/namedash.h
  99.      392     193 50.7% 13-Jan-95 22:34:58  c2man-2.0/eg/oldstyle.c
  100.      498     307 38.3% 13-Jan-95 22:34:56  c2man-2.0/eg/returnlist.h
  101.      319     221 30.7% 13-Jan-95 22:34:58  c2man-2.0/eg/sections.c
  102.      246     168 31.7% 13-Jan-95 22:34:58  c2man-2.0/eg/simplesect.c
  103.      186     125 32.7% 13-Jan-95 22:34:58  c2man-2.0/eg/surround.c
  104.      437     218 50.1% 13-Jan-95 22:34:58  c2man-2.0/eg/underscore.h
  105.      104      85 18.2% 13-Jan-95 22:34:56  c2man-2.0/eg/variable.c
  106.     3890    1253 67.7% 13-Jan-95 22:35:04  c2man-2.0/enum.c
  107.     1201     478 60.1% 13-Jan-95 22:35:06  c2man-2.0/enum.h
  108.      689     387 43.8% 27-Jan-95 22:42:06  c2man-2.0/example.h
  109.     1700     928 45.4% 23-Jan-95 22:16:30  c2man-2.0/fixexamp.in
  110.     1280     601 53.0% 13-Jan-95 22:35:06  c2man-2.0/flatten.SH
  111.    16967    4149 75.5% 23-Jan-95 22:17:36  c2man-2.0/grammar.y
  112.     4128    1072 74.0% 23-Jan-95 22:19:20  c2man-2.0/html.c
  113.     3558    1823 48.7% 23-Jan-95 22:19:44  c2man-2.0/INSTALL
  114.     4130    1158 71.9% 23-Jan-95 22:19:38  c2man-2.0/latex.c
  115.    13870    4496 67.5% 13-Jan-95 22:35:02  c2man-2.0/lex.l
  116.     5090    2132 58.1% 23-Jan-95 22:17:02  c2man-2.0/libc/alloca.c
  117.      461     284 38.3% 23-Jan-95 22:17:38  c2man-2.0/libc/README.libc
  118.     4400    1940 55.9% 23-Jan-95 22:19:20  c2man-2.0/Makefile.SH
  119.     2298    1056 54.0% 23-Jan-95 22:19:44  c2man-2.0/MANIFEST
  120.    35364   10348 70.7% 23-Jan-95 22:19:36  c2man-2.0/manpage.c
  121.     1412     621 56.0% 13-Jan-95 22:35:06  c2man-2.0/manpage.h
  122.     5909    2004 66.0% 23-Jan-95 22:19:40  c2man-2.0/nroff.c
  123.      300     151 49.6% 23-Jan-95 22:19:40  c2man-2.0/nroff.c.rej
  124.     4431    1410 68.1% 23-Jan-95 22:19:26  c2man-2.0/output.h
  125.     3506    1146 67.3% 13-Jan-95 22:35:06  c2man-2.0/PACKLIST
  126.       93      68 26.8% 13-Jan-95 22:35:06  c2man-2.0/PACKNOTES
  127.       40      40  0.0% 23-Jan-95 22:19:12  c2man-2.0/patchlevel.h
  128.      123     112  8.9% 13-Jan-95 22:35:00  c2man-2.0/pc/c2man-32.def
  129.      105      99  5.7% 13-Jan-95 22:35:00  c2man-2.0/pc/c2man.def
  130.     9063    2896 68.0% 13-Jan-95 22:34:58  c2man-2.0/pc/config.h
  131.    17982    6993 61.1% 13-Jan-95 22:34:58  c2man-2.0/pc/COPYING
  132.    20925    7053 66.2% 13-Jan-95 22:34:58  c2man-2.0/pc/getopt.c
  133.     4412    1807 59.0% 13-Jan-95 22:35:00  c2man-2.0/pc/getopt.h
  134.     4142    1678 59.4% 13-Jan-95 22:35:00  c2man-2.0/pc/getopt1.c
  135.     5153    2020 60.7% 23-Jan-95 22:17:00  c2man-2.0/pc/Makefile.pc
  136.     2369     821 65.3% 13-Jan-95 22:35:00  c2man-2.0/pc/popen.c
  137.      170     127 25.2% 13-Jan-95 22:35:00  c2man-2.0/pc/popen.h
  138.      597     354 40.7% 23-Jan-95 22:17:34  c2man-2.0/pc/README.pc
  139.     1889     903 52.1% 23-Jan-95 22:17:08  c2man-2.0/pc/updmake
  140.     4423    2212 49.9% 23-Jan-95 22:19:24  c2man-2.0/README
  141.    16698    4569 72.6% 13-Jan-95 22:35:02  c2man-2.0/semantic.c
  142.     2599     748 71.2% 13-Jan-95 22:35:04  c2man-2.0/semantic.h
  143.     1340     583 56.4% 13-Jan-95 22:35:06  c2man-2.0/strappend.c
  144.      198     160 19.1% 13-Jan-95 22:35:06  c2man-2.0/strappend.h
  145.     1428     573 59.8% 13-Jan-95 22:35:06  c2man-2.0/strconcat.c
  146.      204     160 21.5% 13-Jan-95 22:35:00  c2man-2.0/strconcat.h
  147.     1428     693 51.4% 13-Jan-95 22:35:06  c2man-2.0/string.c
  148.     2368     901 61.9% 13-Jan-95 22:35:04  c2man-2.0/symbol.c
  149.      976     476 51.2% 13-Jan-95 22:35:06  c2man-2.0/symbol.h
  150.     6115    1703 72.1% 23-Jan-95 22:19:40  c2man-2.0/texinfo.c
  151.      172     123 28.4% 23-Jan-95 22:17:38  c2man-2.0/vms/c2man.opt-gcc
  152.      142     107 24.6% 23-Jan-95 22:17:38  c2man-2.0/vms/c2man.opt-vaxc
  153.     9902    3147 68.2% 23-Jan-95 22:16:58  c2man-2.0/vms/config.h
  154.     1792     557 68.9% 23-Jan-95 22:17:30  c2man-2.0/vms/make.com
  155.     4632    1512 67.3% 23-Jan-95 22:17:04  c2man-2.0/vms/popen.c
  156.     4357    1863 57.2% 23-Jan-95 22:17:04  c2man-2.0/vms/readme.1st
  157. -------- ------- ----- --------- --------
  158.   771068  275031 64.3% 05-Feb-95 00:18:20   96 files
  159.